feat: support consumer translator #81

AlinsRan · 2025-04-02T09:20:42Z

Type of change:

What this PR does / why we need it:

#76 Part2

kind: Consumer
metadata:
  name: consumer-sample
spec:
  gatewayRef:
    name: api7ee
  credentials:
    - type: basic-auth
      name: basic-auth-sample
      config:
        username: sample-user
        password: sample-password
  plugins:
    - name: key-auth
      config:
        key: consumer-key

todo:

Add secret support for consumers

Pre-submission checklist:

Did you explain what problem does this PR solve? Or what new features have been added?
Have you added corresponding test cases?
Have you modified the corresponding document?
Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

github-actions · 2025-04-02T10:01:38Z

conformance test report

apiVersion: gateway.networking.k8s.io/v1
date: "2025-04-03T03:47:45Z"
gatewayAPIChannel: standard
gatewayAPIVersion: v1.2.0
implementation:
  contact: null
  organization: API7
  project: api7-ingress-controller
  url: https://github.com/api7/api7-ingress-controller.git
  version: v2.0.0
kind: ConformanceReport
mode: default
profiles:
- core:
    failedTests:
    - HTTPRouteCrossNamespace
    - HTTPRoutePathMatchOrder
    result: failure
    skippedTests:
    - GatewayInvalidTLSConfiguration
    - GatewaySecretInvalidReferenceGrant
    - GatewaySecretMissingReferenceGrant
    - GatewaySecretReferenceGrantAllInNamespace
    - GatewaySecretReferenceGrantSpecific
    - HTTPRouteExactPathMatching
    - HTTPRouteHTTPSListener
    - HTTPRouteHeaderMatching
    - HTTPRouteHostnameIntersection
    - HTTPRouteInvalidBackendRefUnknownKind
    - HTTPRouteInvalidCrossNamespaceBackendRef
    - HTTPRouteInvalidCrossNamespaceParentRef
    - HTTPRouteInvalidNonExistentBackendRef
    - HTTPRouteInvalidParentRefNotMatchingSectionName
    - HTTPRouteInvalidReferenceGrant
    - HTTPRouteListenerHostnameMatching
    - HTTPRouteMatching
    - HTTPRouteMatchingAcrossRoutes
    - HTTPRoutePartiallyInvalidViaInvalidReferenceGrant
    - HTTPRouteReferenceGrant
    - HTTPRouteRequestHeaderModifier
    - HTTPRouteWeight
    statistics:
      Failed: 2
      Passed: 9
      Skipped: 22
  name: GATEWAY-HTTP
  summary: Core tests failed with 2 test failures.

api/adc/types.go

internal/controller/consumer_controller.go

dspo · 2025-04-03T02:59:53Z

test/e2e/crds/consumer.go

+spec:
+  gatewayRef:
+    name: api7ee
+  plugins:


dashboard 中几个认证类型的插件已经不能在 "插件" 中启用了, 这里应当与 dashboard 保持一致.

admin api 是可以的。我测过，ingress 模式可以启用，那个是 dashboard 拦截，后端并没有拦截，ingress 有拦截的必要吗？而且考虑还要对接 apisix.

这里的测试下个 PR 会删掉，这是不推荐的用法。

test/e2e/crds/consumer.go

test/e2e/scaffold/k8s.go

Copilot

Pull Request Overview

This PR introduces support for consumer translation, enhancing the API7 Ingress Controller by incorporating consumer-related functionality into ADC translation and associated e2e tests.

New e2e tests and CRDs for Consumer resources
Integration of consumer credentials and plugins in ADC translation
Updates to consumer controller indexing and reconciliation for improved status management

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
test/e2e/scaffold/k8s.go	Added helper to apply resource changes in tests
test/e2e/e2e_test.go	Updated test imports to include consumer CRDs
test/e2e/crds/consumer.go	Introduced e2e tests for Consumer and Credential support
internal/provider/provider.go	Extended translation context to include credentials
internal/provider/adc/translator/translator.go	Added Consumers field to translation result
internal/provider/adc/translator/consumer.go	Implemented Consumer translation for ADC
internal/provider/adc/adc.go	Integrated consumer support in ADC update and delete workflows
internal/controller/status.go	Introduced status condition helpers for consumer resources
internal/controller/indexer/indexer.go	Added indexer for consumer gateway reference
internal/controller/consumer_controller.go	Updated consumer controller with indexing, reconciliation, and secret processing
config/crd/bases/gateway.apisix.io_pluginconfigs.yaml	Minor CRD adjustments
config/crd/bases/gateway.apisix.io_consumers.yaml	Updated CRD defaults and validation for Consumer resources
api/adc/types.go	Updated consumer type definitions and name composition

test/e2e/crds/consumer.go

internal/controller/consumer_controller.go

Copilot

Pull Request Overview

This PR implements support for translating Consumer resources in the ADC provider and adds corresponding end-to-end tests. Key changes include:

Adding new e2e test cases and scaffold functions for Consumer resources.
Implementing consumer translation logic including credentials handling in the ADC translator.
Updating CRD definitions, indexers, and controllers to support Consumer resource reconciliation.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
test/e2e/scaffold/k8s.go	Added ResourceApplied helper for resource creation and status check.
test/e2e/e2e_test.go	Updated imports to include new CRDs for consumers.
test/e2e/crds/consumer.go	Added comprehensive e2e tests for Consumer plugins and credentials.
internal/provider/provider.go	Extended TranslateContext with Credentials field.
internal/provider/adc/translator/translator.go	Introduced Consumers field in the translation result.
internal/provider/adc/translator/httproute.go	Added nil-check before unmarshalling plugin config data.
internal/provider/adc/translator/consumer.go	Implemented translation logic for Consumer resources.
internal/provider/adc/adc.go	Updated ADC update and delete flow to include Consumer resources.
internal/controller/status.go	Introduced status helper functions for consumer status conditions.
internal/controller/indexer/indexer.go	Added Consumer indexer using a new ConsumerGatewayRef field.
internal/controller/consumer_controller.go	Updated reconciliation for Consumer resources including secret fetching and status update.
config/crd/bases/gateway.apisix.io_consumers.yaml	Updated CRD definitions with defaults and validation for gatewayRef.
api/v1alpha1/consumer_types.go	Made gatewayRef.Name required and added default values for Kind and Group.
api/adc/types.go	Updated Consumer type and added ComposeConsumerName helper function.

Comments suppressed due to low confidence (1)

test/e2e/crds/consumer.go:223

The variable name 'updateCrendential' appears to be misspelled. Consider renaming it to 'updateCredential' for clarity.

var updateCrendential = `apiVersion: gateway.apisix.io/v1alpha1

AlinsRan added 3 commits April 2, 2025 09:19

feat: support consumer translator

c86cfcb

add test case

10fbf27

add test case

38558c3

AlinsRan force-pushed the feat/consumer-translator2 branch from 15a1333 to 38558c3 Compare April 2, 2025 09:46

AlinsRan requested a review from dspo April 2, 2025 09:52

dspo approved these changes Apr 3, 2025

View reviewed changes

dspo requested a review from Copilot April 3, 2025 03:03

Copilot AI reviewed Apr 3, 2025

View reviewed changes

test/e2e/crds/consumer.go Outdated Show resolved Hide resolved

internal/controller/consumer_controller.go Outdated Show resolved Hide resolved

AlinsRan added 3 commits April 3, 2025 03:21

resolve comment

edba3ff

resolve comment 2

a15a67a

resolve comment 3

4eb85d9

AlinsRan requested a review from Copilot April 3, 2025 03:26

Copilot AI reviewed Apr 3, 2025

View reviewed changes

AlinsRan added 2 commits April 3, 2025 03:30

fix test

a6f11a3

resolve comment 4

8ec33d0

AlinsRan merged commit aebd2af into release-v2-dev Apr 3, 2025
8 checks passed

AlinsRan deleted the feat/consumer-translator2 branch April 3, 2025 04:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: support consumer translator #81

feat: support consumer translator #81

Uh oh!

AlinsRan commented Apr 2, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dspo Apr 3, 2025

Uh oh!

AlinsRan Apr 3, 2025 •

edited

Loading

Uh oh!

dspo Apr 3, 2025

Uh oh!

AlinsRan Apr 3, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: support consumer translator #81

feat: support consumer translator #81

Uh oh!

Conversation

AlinsRan commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of change:

What this PR does / why we need it:

Pre-submission checklist:

Uh oh!

github-actions bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

conformance test report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dspo Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

AlinsRan Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dspo Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

AlinsRan Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AlinsRan commented Apr 2, 2025 •

edited

Loading

github-actions bot commented Apr 2, 2025 •

edited

Loading

AlinsRan Apr 3, 2025 •

edited

Loading

AlinsRan Apr 3, 2025 •

edited

Loading